home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr01 / halcn305.zip / READ.ME < prev    next >
Text File  |  1993-08-12  |  18KB  |  459 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.                                     HALCYON
  12.  
  13.                                   Version 3.0
  14.  
  15.                                GRIFFIN SOLUTIONS
  16.  
  17.                              dBase III, IV access
  18.  
  19.                                 12 August 1993
  20.  
  21.                 (C) Copyright 1991,1992, 1993 - All Rights reserved
  22.  
  23.  
  24.                                Griffin Solutions
  25.                              102 Molded Stone Place
  26.                           Warner Robins, Georgia 31088
  27.                              Voice: (912) 953-2680
  28.                              Fax:   (912) 953-5517
  29.                              CompuServe: 75206.231
  30.                       The Consultant BBS: (718) 837 3236
  31.  
  32.          ---------------------------------------------------------------
  33.  
  34.          These Turbo Pascal routines handle processing for dBase III/IV
  35.          files, including memo (.DBT), index (.NDX), and data (.DBF) files.
  36.          Use is made of object oriented programming to simplify the user
  37.          interface.  Examples of the user interface is demonstrated in the
  38.          sample programs.
  39.  
  40.          This release is valid for reading and writing of data, index, and
  41.          memo files.  Routines will compile under TP 5.5, TP 6.0, TP 7.0,
  42.          and Turbo Pascal for Windows.
  43.  
  44.  
  45.  
  46.          HALCYON was previously named GS_DBASE.  The name was changed to
  47.          emphasize how serene the routines make dBase file access pro-
  48.          gramming.
  49.  
  50.  
  51.  
  52. --------------------------------------
  53. dBase is a trademark of Ashton-Tate
  54. Turbo Pascal is a trademark of Borland International, Inc
  55. Griffin Solutions
  56.  
  57.  
  58.                               INTRODUCTION
  59.  
  60.  
  61. 1.  FEATURES
  62.  
  63. Welcome to HALCYON, a series of Turbo Pascal routines for management of
  64. dBase III and IV files.  The routines are designed to do the following:
  65.  
  66.   - Provide a simple user interface to read and write dBase III and IV
  67. files in a network environment.
  68.  
  69.   - Allow creation, use and updating of multiple dBase .NDX index files in
  70. reading and updating the dBase III and IV data (DBF) files.  The .MDX index
  71. files are not supported (This may change if demand warrants).
  72.  
  73.   - Allow creation, use and updating of multiple Clipper .NTX index files
  74. in reading and updating the dBase III data (DBF) files.
  75.  
  76.   - Allow reading and updating of .DBT memo file entries.
  77.  
  78.   - Allow creation of new dBase III or IV files.  These routines will work
  79. with either dBase III and IV memo file structures.  However, these formats
  80. are not interchangeable.
  81.  
  82.   - Provide expanded routines to display, edit, and update dBase files.
  83.  
  84.   - Provide a file handler interface that provides a simple disk management
  85. capability including file sharing for LANs.
  86.  
  87.   -  Allow operation under all versions of Object Oriented Turbo Pascal,
  88. including Turbo Pascal for Windows.
  89.  
  90.   - Do all of the above using only Turbo Pascal--no assembly routines are
  91. used.
  92.  
  93.   - Apply Object Oriented Programming to create easily usable modules.
  94.  
  95. One significant difference between version 3.0 and previous releases is the
  96. elimination of Griffin Solutions unique window routines.  These were mainly
  97. included to allow demonstration of the routines and were not intended to be
  98. central to the database engine routines.  They have been eliminated to allow
  99. better interface to MicroSoft Windows and Borland TurboVision, as well as
  100. the many commercial, shareware, and public domain windowing packages.  If
  101. there is enough demand, the old window routines will be dusted off, polished
  102. up, and provided as a separate package at minimal cost.
  103.  
  104.  
  105. 2.  SHAREWARE
  106.  
  107. HALCYON is copyrighted. It is not a public domain program.  It is being
  108. distributed as Shareware, which means that unmodified copies of the software
  109. and documentation may be freely copied and shared.  I ask in return that
  110.  
  111.  
  112.                                       2
  113.                                                              Griffin Solutions
  114.  
  115.  
  116. should you find HALCYON to be useful, you become a registered user.  You
  117. become registered by filling out the order form at the end of this paper
  118. and including a check for $89.95. For your convenience, the order form is
  119. included as a separate file as well (ORDER.FRM).  Alternatively, you may
  120. order online through CompuServe.  Type GO SWREG, and register Software
  121. Registration Number 765.
  122.  
  123. By registering you will get:
  124.  
  125.         o  A copy of the latest version of the program, including all the
  126.            source code for all units.
  127.  
  128.         o  The right to use the Griffin Solutions routines in your
  129.            programs, including any commercial application.  (This
  130.            right does not extend to distributing the Griffin Solutions
  131.            source code.  Executable code may be freely distributed)
  132.  
  133.         o  Automatic notification of major program updates.
  134.  
  135.         o  Technical support (one year).
  136.  
  137.         o  A printed user's manual with expanded tutorial software
  138.  
  139. The shareware philosophy is to pay smaller amounts for well-crafted and
  140. useful software from developers who cannot spend the millions of dollars on
  141. marketing necessary to compete with the large software development
  142. companies.  You benefit by being able to try a wider variety of software
  143. products to find the ones that suit your particular purpose. And the trial
  144. is free. The shareware developer benefits from being able to distribute his
  145. work to a wider audience than would be possible through normal channels.
  146.  
  147. Your share of the responsibility for shareware to continue, and to support
  148. the development of more and better products is to distribute your shareware
  149. programs to others and become a registered user of those products you like
  150. and use.
  151.  
  152. Technical support is available through the following sources:
  153.  
  154. ┌─────────────────────────────────────────┬───────────────────────────────┐
  155. │ Mail: Griffin Solutions                 │   Telephone: (912) 953-2680   │
  156. │       102 Molded Stone Place            │   Fax:   (912) 953-5517       │
  157. │       Warner Robins, Georgia 31088, USA │   CompuServe: 75206.231       │
  158. ├─────────────────────────────────────────┴───────────────────────────────┤
  159. │  The Consultant BBS, at 718-837-3236, supporting v32bis/HST at speeds   │
  160. │  from 1200 to 16.8Kbps.  This 4-node ASP-approved BBS features author-  │
  161. │  direct shareware.                                                      │
  162. └─────────────────────────────────────────────────────────────────────────┘
  163.  
  164. 3.  GETTING STARTED
  165.  
  166. This section will acquaint you with the files on the distribution disk and
  167. show you a demonstration to quickly see what HALCYON can accomplish.
  168.  
  169.  
  170.                                       3
  171. Griffin Solutions
  172.  
  173. HALCYON Units:
  174. --------------
  175.                 GS_BUILD.PAS     TPU Builder
  176.                 GSOBSHEL.PAS     Primary user interface to HALCYON
  177.                 GSOB_DBF.PAS     Basic dBase file handling routines
  178.                 GSOB_DBS.PAS     Advanced dBase routines
  179.                 GSOB_DSK.PAS     Disk I/O routines
  180.                 GSOB_DTE.PAS     Date handling routines
  181.                 GSOB_EDT.PAS     Editor routines (non-Windows)
  182.                 GSOB_FLP.PAS     Floating point conversion
  183.                 GSOB_GEN.PAS     Generate test dBase files
  184.                 GSOB_INX.PAS     Virtual table routines
  185.                 GSOB_MMO.PAS     Memo file routines
  186.                 GSOB_NDX.PAS     Index routines (dBase .NDX)
  187.                 GSOB_NTX.PAS     Index routines (Clipper .NTX)
  188.                 GSOB_OBJ.PAS     Basic object structures
  189.                 GSOB_STR.PAS     String handling routines
  190.                 GSOB_VAR.PAS     Global variables
  191.                 GSV_FLDS.PAS     Field handling for TurboVision
  192.                 GSXT_BRO.PAS     File Browser Unit
  193.                 GSXT_SCH.PAS     File Searcher Unit
  194.  
  195. Text Files:
  196. -----------
  197.                 CHANGES .TXT     Latest version changes
  198.                 GS_HELP .ASC     Basic Documentation for HALCYON
  199.                 ORDER   .FRM     Registration Form
  200.                 READ    .ME      Quick introduction file
  201.                 TESTDATA.FIL     Data to construct test files
  202.                 WISDOM  .FIL     Quotes to construct memo records
  203.  
  204.  
  205. Demonstration Files:
  206. --------------------
  207.                 GSDMO_01.PAS     DBase File Creator
  208.                 GSDMO_02.PAS     DBase File Lister
  209.                 GSDMO_03.PAS     DBase File Formated Lister
  210.                 GSDMO_04.PAS     DBase File Updating
  211.                 GSDMO_05.PAS     DBase File Appending
  212.                 GSDMO_06.PAS     DBase File Indexing
  213.                 GSDMO_07.PAS     DBase Memo File Lister
  214.                 GSDMO_08.PAS     DBase File Structure Lister
  215.                 GSDMO_09.PAS     DBase Index Creator
  216.                 GSDMO_10.PAS     DBase Multiple Indexes
  217.                 GSDMO_11.PAS     DBase Relational File Maker
  218.                 GSDMO_12.PAS     DBase Relational File Linkage
  219.                 GSDMO_13.PAS     DBase Relational File Linkage
  220.                 GSDMO_14.PAS     DBase File Maker
  221.                 GSDMO_15.PAS     DBase File and Memo Builder
  222.                 GSDMO_16.PAS     DBase File/Memo Editor (External)
  223.                 GSDMO_17.PAS     DBase Status Checker
  224.                 GSDMO_18.PAS     DBase Error Handler
  225.                 GSDMO_19.PAS     DBase File Sorting
  226.  
  227.  
  228.                                      4
  229.                                                              Griffin Solutions
  230.  
  231. Demonstration Files (Other Than dBase Engine):
  232. ----------------------------------------------
  233.  
  234.                 GSDMO_20.PAS     DBase Reindexing
  235.                 GSDMO_21.PAS     DBase Copy File and Structure
  236.                 GSDMO_22.PAS     Getting More Files Open
  237.                 GSDMO_23.PAS     DBase Filters
  238.                 GSDMO_ED.PAS     DBase Editor
  239.                 GSDMO_VU.PAS     DBase Viewer
  240.                 GSDMOTV1.PAS     DBase File Display
  241.                 GSDMOTV2.PAS     DBase File Display
  242.                 SHOWOFF .EXE     Demonstration program
  243.                 SHOWOFF .PAS     Demonstration program source
  244.                 SMPLSTUF.PAS     Extra screen display routines
  245.                 TESTBROW.PAS     File Browser Demonstration
  246.                 TESTFIND.PAS     Record Finder Demonstration
  247.                 TESTFRM1.PAS     User-assigned Formulas for Indexes (#1)
  248.                 TESTFRM2.PAS     User-assigned Formulas for Indexes (#2)
  249.                 TESTPICK.PAS     Using a Pick List for dBase Records
  250.                 TESTSCH1.PAS     Searching a dBase File for Key Word
  251.                 TESTSCH2.PAS     Searching with Progress Reporting
  252.                 TUTOR1  .DBF     Demonstration sample dBase File
  253.                 XTRASTUF.PAS     Extra dBAse field display routines
  254.  
  255.  
  256. External Editor Files:  (Public domain, used to show external editor call)
  257. ----------------------
  258.  
  259.                 TE      .DOC     TE 2.5 User's Guide (10 pages)
  260.                 TE      .EXE     The actual Text Editor program
  261.                 TEG     .HLP     TE 2.5 Command Summary (1 page)
  262.                 TEMOD   .EXE     Utility to change TE.EXE options
  263.                 TEREAD  .1ST     Information file
  264.  
  265.  
  266.  
  267. Installation
  268.  
  269. Installation consists of copying these files to your hard disk.  The basic
  270. documentation (61 pages) may be printed by typing 'COPY GS_HELP.ASC PRN' at
  271. the DOS prompt.  It is formatted for 8.5" X 11" paper and 10-pitch font.
  272.  
  273.  
  274. Demonstration
  275.  
  276. You can run SHOWOFF.EXE to get an immediate feel for the capabilities in
  277. the HALCYON library of routines.  The source is also included.  This
  278. program is a data file browser/editor that is very useful for examining the
  279. data files that are created and modified in the remaining demonstration
  280. programs.
  281.  
  282. 1.  Execute the program, and look at the screen display.  You have a
  283.     choice of File, Index, Edit, Append, Browse, and Quit.  You must
  284.     select File before any other choice (except Quit) can be selected.
  285.  
  286.                                       5
  287. Griffin Solutions
  288.  
  289. 2.  By pressing Return with File highlighted, a directory of all .DBF
  290.     files will be displayed, along with the other directories and drives
  291.     that may be selected.  Choose a file.  If you don't have any, you
  292.     can use TUTOR1.DBF, included with these files.
  293.  
  294. 3.  Once a file is selected, an existing index (.NDX) file can be chosen
  295.     if it exists.  This is done through the Index selection.
  296.  
  297. 4.  You may now Edit, Append, or Browse the file.  Help information is
  298.     for these functions is available by pressing F1 in the function.
  299.  
  300. 5.  A new file may be opened by returning to the File menu selection.
  301.  
  302. To get the feeling of the speed and features of HALCYON, run the set of
  303. demonstration programs starting with GSDMO_01.PAS.  These are described in
  304. the basic documentation and within the source program itself.
  305.  
  306.  
  307.  
  308. 4.  CHANGES
  309.  
  310. Major changes in HALCYON Version 3.0:
  311. ──────────────────────────────────────
  312.  
  313.      -  A new user interface is included that makes the 'object' part of
  314. object oriented programming transparent.  The programmer simply uses a
  315. set of commands similar to the dBase commands to control the file access.
  316.  
  317.      -  The routines work under all versions of Turbo Pascal from 5.5 on
  318. through 7.0.  The routines work equally well in Turbo Pascal for windows.
  319. Routines will work in real or protected mode.
  320.  
  321.      -  File sharing is allowed in network environments.
  322.  
  323.      -  File sorting is allowed.
  324.  
  325.      -  File copying, and copying of the file structure only, is allowed.
  326.  
  327.      -  File filters are permitted by hooking user routines to file reads.
  328. The user interface required to set up the hook is minimal.
  329.  
  330.      -  More than 15 files can be used at the same time by using a command
  331. to increase the number of files available.
  332.  
  333.      -  Index processing is much faster in version 3.0.
  334.  
  335.      -  Reindexing has been added to simplify Pack operations.  All open
  336. index files are reindexed automatically upon a call to Reindex.
  337.  
  338.      -  The number of indexes allowed per file is increased to 64.  This
  339. can be changed by the programmed.
  340.  
  341.      -  The user has the ability to hook status and error reports to take
  342. whatever actions are needed.
  343.  
  344.                                       6
  345.                                                              Griffin Solutions
  346.  
  347.  
  348. Major changes in GS_dBase Version 2.8:
  349. ──────────────────────────────────────
  350.  
  351.      -  Multiple indexes (up to 16) are allowed.
  352.  
  353.      -  Clipper indexes (.NTX) are allowed to replace .NDX files by changing
  354. one Uses statement in GS_DBASE.PAS.
  355.  
  356.      -  A File_TOF flag is added to test when access to a Prev_Record
  357. record is made while at the top of the file.
  358.  
  359.      -  Required memory is reduced by 10K by eliminating the numeric
  360. coprocessor emulation to handle numeric key expressions for .NDX files.
  361.  
  362.      -  Disk cache routines are eliminated in GS_FileH.  Processing speed
  363. is maintained by adding a node 'stack' in index processing to handle the
  364. most frequently used index nodes.
  365.  
  366.      -  A 'Zap' procedure is now included.
  367.  
  368.  
  369. Major changes in GS_dBase Version 2.5:
  370. ──────────────────────────────────────
  371.  
  372.      -  Dates are now handled as longint values using their Julian Date.
  373. This simplifies date calculations.  See GS_Date unit for details.
  374.  
  375.      -  A windows interface is added to facilitate use of other window
  376. handling packages to replace GS_Wind.  GS_Wind is renamed GS_Windw.
  377.  
  378.      -  Additional string handling functions have been added.
  379.  
  380.      -  A StatusUpdate routine is available to allow the programmer to
  381. capture the progress of long-running routines such as Pack and IndexTo.
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.                                       7
  403.  
  404.  
  405.  
  406.                               GRIFFIN SOLUTIONS
  407.  
  408.                            ORDER/REGISTRATION FORM
  409.  
  410.        Quan.        Program               Unit Price         Total
  411.  
  412.        ____         HALCYON Ver 3.0         $89.95          _______
  413.  
  414.        ____         HALCYON Ver 3.0         $25.00          _______
  415.                     (Upgrade for Registered Users of)
  416.                     (GS_dBase 2.8 and earlier       )
  417.  
  418.        ____         GS_dBase Ver 2.9        $25.00          _______
  419.  
  420.  
  421.                     Overseas Shipping        $5.00          _______
  422.  
  423.  
  424.                                            Total:           _______
  425.  
  426.             _____  I have included a check for  :           _______
  427.  
  428.  
  429.        (Canadians send Canadian POSTAL MONEY ORDER made payable in US $.)
  430.  
  431.  
  432.  
  433.        DISK SIZE (circle one):        5.25" (360K)      3.5"  (720K)
  434.                                       5.25" (1.2M)      3.5"  (1.4M)
  435.  
  436.  
  437.        ** Includes one year free support.
  438.  
  439.        YOUR NAME: ________________________ COMPANY:  _____________________
  440.  
  441.        ADDRESS: __________________________________________________________
  442.  
  443.        CITY: _____________________________ STATE: ____   ZIP: ____________
  444.  
  445.        DAY TIME PHONE (in case of questions):  ___________________________
  446.  
  447.        How did you hear about this program? :  ___________________________
  448.  
  449.                        THANK YOU FOR SUPPORTING SHAREWARE!
  450.  
  451.  
  452.                                 Griffin Solutions
  453.                               102 Molded Stone Place
  454.                            Warner Robins, Georgia 31088
  455.                               Voice: (912) 953-2680
  456.                               Fax:   (912) 953-5517
  457.                               CompuServe: 75206.231
  458.                         The Consultant BBS: (718) 837 3236
  459.